home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr08 / btrreq.zip / BTRREQ.DOC < prev    next >
Text File  |  1993-06-26  |  17KB  |  384 lines
  1. Filename: BTRREQ.DOC
  2. Product:  Btrieve v6.1x Requesters for DOS, Windows, and OS/2
  3. Date:     March 1993
  4.  
  5. ===========================================================================
  6. Disclaimer
  7. ==========
  8.  
  9.    Novell, Inc. makes no representations or warranties with respect to
  10.    any NetWare software, and specifically disclaims any express or implied
  11.    warranties of merchantability, title, or fitness for a particular purpose.
  12.  
  13.    Distribution of any NetWare software is forbidden without the express
  14.    written consent of Novell, Inc. Further, Novell reserves the right to
  15.    discontinue distribution of any NetWare software.
  16.  
  17.    Novell is not responsible for lost profits or revenue, loss of use of
  18.    the software, loss of data, costs of re-creating lost data, the cost
  19.    of any substitute equipment or program, or claims by any party other
  20.    than you. Novell strongly recommends a backup be made before any
  21.    software is installed. Technical support for this software may be
  22.    provided at the discretion of Novell.
  23.  
  24. ===========================================================================
  25. Contents
  26. ========
  27.  
  28.    File Information
  29.    Installation & Compatibility
  30.    Upgrade File Descriptions
  31.    Using the Requesters
  32.       DOS Requester
  33.       OS/2 Requester
  34.       Windows Requester
  35.  
  36. ===========================================================================
  37. File Information
  38. ================
  39.  
  40. Filename:  BTRREQ.ZIP
  41.  
  42. Date:      3/29/93
  43.  
  44. Files Included:
  45. BTRREQ   DOC     This file
  46. BREQUEST EXE     59526 01-29-93   3:40p
  47. WBTRVRES DLL     22912 01-30-93  12:16p
  48. BTRCALLS DLL     21154 03-09-93  10:08a
  49. WBTRCALL DLL     14075 03-01-93   9:40a
  50. NDBCOMM  DLL     20343 01-29-93   4:16p
  51. NDBCNVT  EXE     18192 01-29-93   1:40p
  52. WNDBCNVT EXE     30926 01-30-93  12:08p
  53. NOVDB    INI      2495 08-26-92   4:48p
  54.  
  55. ===========================================================================
  56. Installation & Compatibility
  57. ============================
  58.  
  59. The Btrieve 6.1x Requesters can be used with the following NLMs and VAPs:
  60.  
  61.         Btrieve NLM v5.15
  62.         Btrieve VAP v5.15
  63.         Btrieve NLM v6.0
  64.  
  65. To install the requesters, simply replace the existing requester with the
  66. new requester contained with this update.
  67.  
  68. ===========================================================================
  69. Upgrade File Descriptions
  70. =========================
  71.  
  72.   BTRREQ.DOC           This README file
  73.  
  74.   Files related to workstation operation:
  75.  
  76.     BREQUEST.EXE v6.10   The Btrieve Requester for DOS that must be loaded
  77.                          at each workstation sending Btrieve requests
  78.                          to the server. (See the section titled "DOS
  79.                          Requester" under "Using the Requesters" for
  80.                          more information.)
  81.     BTRCALLS.DLL v6.10a  The Btrieve Requester for OS/2 that must be loaded
  82.                          at each workstation sending Btrieve requests
  83.                          to the server. (See the section titled "OS/2
  84.                          Requester" under "Using the Requesters" for
  85.                          more information.)
  86.     NDBCNVT.EXE  v6.10   The OS/2 conversion utility that converts BTRCALLS.DLL
  87.                          to BTRLOCL.DLL. (See the section titled "OS/2
  88.                          Requester" under "Using the Requesters" for
  89.                          more information.)
  90.     NDBCOMM.DLL  v6.10  The communications Requester for OS/2 workstations
  91.                          that provides the necessary data communications
  92.                          between the workstation and the Btrieve NLM.
  93.                          (See the section titled "OS/2 Requester" under
  94.                          "Using the Requesters" for more information.)
  95.     WBTRCALL.DLL v6.10a  The Btrieve Requester for Windows that must be loaded
  96.                          at each workstation sending Btrieve requests
  97.                          to the server. (See the section titled
  98.                          "Windows Requester" under "Using the Requesters"
  99.                          for more information.)
  100.     WNDBCNVT.EXE v6.10   The Windows conversion utility that converts
  101.                          WBTRCALL.DLL to WBTRLOCL.DLL.(See the section titled
  102.                          "Windows Requester" under "Using the Requesters"
  103.                          for more information.)
  104.     NOVDB.INI            The initialization file for the Windows Requester.
  105.                          (See the section titled "Windows Requester" under
  106.                          "Using the Requesters" for more information.)
  107.     WBTRVRES.DLL v6.10  The resource library that is used in the Windows
  108.                          operating environment.
  109.  
  110. ===========================================================================
  111. Using the Requesters
  112. ====================
  113.  
  114.    Btrieve provides Requesters for DOS, OS/2, and Windows applications.
  115.    This section provides configuration options and instructions for loading
  116.    and unloading the Requester in each operating environment.
  117.  
  118.    The Btrieve Requesters have changed (primarily in key definition) between
  119.    previous versions and Btrieve v6.x. Therefore, all workstations accessing
  120.    the Btrieve NLM must use the Btrieve v6.x Requesters.
  121.  
  122.  
  123. DOS Requester
  124. -------------
  125.  
  126.    You must load the Btrieve DOS Requester, BREQUEST.EXE, at a workstation
  127.    before that workstation can access network Btrieve files using the Btrieve
  128.    NLM. The DOS Requester loads into a DOS workstation's memory as a Terminate
  129.    and Stay Resident (TSR) program. You can access local as well as remote
  130.    files by running both client-based (local) Btrieve and the Requester at
  131.    your workstation.
  132.  
  133.  
  134. DOS Requester Configuration Options
  135.  
  136.    There are two configuration options for the DOS Requester: Data Message
  137.    Length (/D) and Help (/?). Previous versions of Btrieve supported the /S
  138.    and /R options. Btrieve v6.x accepts the /S and /R options for backwards
  139.    compatibility, but otherwise ignores them.
  140.  
  141.    Data Message Length (/D)
  142.    Range: 532 through 57,000 bytes
  143.    Default: 4,096 bytes
  144.    Memory Required: 538 bytes + data message length
  145.  
  146.    This option specifies the length of the largest record you want to
  147.    access through Btrieve. (If you omit this option, the Requester
  148.    uses the default value, 4,096.) The Requester uses this value to
  149.    calculate the length of the data message buffer reserved for passing
  150.    records between Btrieve and your applications. The Requester maintains
  151.    one copy of the data message buffer.
  152.  
  153.    The value you enter here should not exceed the largest record size
  154.    you configure for Btrieve through the Setup utility since that is the
  155.    maximum message that BSPXCOM can receive.
  156.  
  157.    NOTE:  Specifying a higher value than you need for the /D option
  158.           does not improve performance.
  159.  
  160.    Help (/?)
  161.    The /? option lists the only other option that is used, /D, and
  162.    mentions that although the /S and /R options are for backwards
  163.    compatibility, Btrieve v6.x ignores them.
  164.  
  165.  
  166. Loading the DOS Requester
  167.  
  168.    Load the DOS Requester at the workstation by entering the following
  169.    command:
  170.  
  171.       [path] BREQUEST [/D:dataMsgLength]
  172.  
  173.    path    The pathname to the directory where the DOS Requester is stored.
  174.            You can omit the pathname if the DOS Requester is stored on the
  175.            default drive or if it is located in a directory in your search
  176.            path.
  177.  
  178.    For example, if the Requester is on the default drive and you want to
  179.    specify a 2,048-byte data message length, enter BREQUEST /D:2048.
  180.  
  181.    NOTE:  The forward slash (/) before the configuration option is the
  182.           only valid character you can use. If you specify a dash (-) or
  183.           a backslash (\), the Requester may load improperly.
  184.  
  185.    To ensure that the DOS Requester is always loaded with the /D option set
  186.    to a particular value, place the BREQUEST command in the workstation's
  187.    AUTOEXEC.BAT file.
  188.  
  189.  
  190. Unloading the DOS Requester
  191.  
  192.    At a DOS workstation, you can use two methods to unload the DOS
  193.    Requester:
  194.  
  195.    - Your application can issue a Stop operation (Btrieve
  196.      operation 25).
  197.  
  198.    - You can issue the stop command in the BUTIL utility from the
  199.      workstation's command line.
  200.  
  201.  
  202. OS/2 Requester
  203. --------------
  204.  
  205.    The following files must be loaded in a directory listed in an OS/2
  206.    workstation's LIBPATH before a Btrieve application can access the network
  207.    from that workstation:
  208.  
  209.    BTRCALLS.DLL - the Btrieve dynamic link Requester for OS/2 workstations.
  210.    NDBCOMM.DLL  - the communications Requester for OS/2 workstations.
  211.                   NDBCOMM.DLL provides the necessary data communications between
  212.                   the workstation and the Btrieve NLM.
  213.  
  214.    You can access local as well as remote files by running both client-based
  215.    (local) Btrieve and the Requester at your workstation. If you want to run
  216.    both client-based Btrieve and the Requester, you must use the OS/2
  217.    conversion utility (NDBCNVT.EXE) to convert BTRCALLS.DLL to BTRLOCL.DLL.
  218.    You must type NDBCNVT on the command line to use this utility.
  219.    (By default, the Requester and the client-based Btrieve have the same
  220.    name.)
  221.  
  222.  
  223. OS/2 Requester Configuration Options
  224.  
  225.    You are not required to specify any configuration options for the OS/2
  226.    Requester. Since the internal tables that control the options are not
  227.    fixed, the tables will grow as needed. However, if you prefer to set
  228.    the initial size of the tables, you can do so using the Data Message
  229.    Length (/D) and the Number of Servers (/S) options.
  230.  
  231.    Data Message Length (/D)
  232.    Range: 532 through 65,000 bytes
  233.    Default: 4,096 bytes
  234.    Memory Required: 538 bytes + data message length
  235.  
  236.    The /D option specifies the length of the largest record you want
  237.    to access through Btrieve. The OS/2 Requester uses this value to
  238.    calculate the length of the data message buffer reserved for passing
  239.    records between Btrieve and your applications. The Requester maintains
  240.    one copy of the data message buffer.
  241.  
  242.    The value you enter here should not exceed the value you specified for
  243.    the Largest Record Size configuration option in the Setup utility.
  244.    The value for this option represents the maximum message length that
  245.    BSPXCOM can receive.
  246.  
  247.    NOTE:  Specifying a higher value than you need for the /D option
  248.           does not improve performance.
  249.  
  250.    Number of Servers (/S)
  251.    Range: 1 through 255
  252.    Default: 8
  253.    Memory Required: 27 bytes per server
  254.  
  255.    The /S option specifies the number of servers that have the Btrieve
  256.    NLM active on the network.
  257.  
  258.    NOTE:  The forward slash (/) before the configuration option is the only
  259.           valid character you can use. If you specify a dash (-) or a backslash
  260.           (\), the Requester may load improperly.
  261.  
  262.  
  263. Configuring the OS/2 Requester
  264.  
  265.    Set the Requester configuration options using the following command:
  266.  
  267.       SET BRQPARMS=/D:dataMsgLength /S:numberOfServers
  268.  
  269.    Do not include a space between BRQPARMS and the equal sign. You can,
  270.    however, insert a space between each configuration option you specify.
  271.  
  272.  
  273. Loading the OS/2 Requester
  274.  
  275.    An application may load the Btrieve for OS/2 Requester in one of the
  276.    following two ways:
  277.  
  278.    Implicitly - Your application can implicitly load the OS/2 Requester
  279.    by either linking with the import library BTRCALLS.LIB or by specifying
  280.    imported functions in the application definition file. If your
  281.    application uses this method, the operating system loads the OS/2
  282.    Requester automatically when the application is started.
  283.  
  284.    Explicitly - Your application can load the OS/2 Requester explicitly
  285.    using the operating system API functions. When the application loads
  286.    the Requester explicitly, the operating system does not load the OS/2
  287.    Requester until notified to do so.
  288.  
  289.  
  290. Unloading the OS/2 Requester
  291.  
  292.    At an OS/2 workstation, the operating system removes the dynamic link
  293.    routines from memory when the application terminates or when the
  294.    application explicitly unloads the OS/2 Requester using the operating
  295.    system API.
  296.  
  297.    Logging out of one or more servers from a workstation does not close
  298.    Btrieve files or terminate the Btrieve SPX connection to the server.
  299.    To close files and terminate the connection, you must either issue a
  300.    STOP command or reboot the server.
  301.  
  302.  
  303. Windows Requester
  304. -----------------
  305.  
  306.    In the Windows environment, you must load the DOS Requester, BREQUEST.EXE,
  307.    before starting Windows. Windows-based Btrieve applications access the
  308.    Requester by means of a DLL, WBTRCALL.DLL, which uses the DOS Protected
  309.    Mode Interface (DPMI) that Windows provides.
  310.  
  311.    The Windows Requester (that is, WBTRCALL.DLL) is the Btrieve interface DLL
  312.    for Windows v3.x. The DLL provides the same API as client-based Btrieve
  313.    and requires no modification to the application.
  314.  
  315.    You can access local as well as remote files by running both client-based
  316.    (local) Btrieve and the Requester at your workstation. If you want to run
  317.    both client-based Btrieve and the Requester, you must run the Windows
  318.    Conversion utility (WNDBCNVT.EXE) to convert WBTRCALL.DLL to WBTRLOCL.DLL.
  319.    You must type WNDBCNVT on the command line to use this utility.
  320.  
  321. Windows Requester Configuration Options
  322.  
  323.    The following list describes the available configuration options for
  324.    the Windows Requester. These options should be specified in the NOVDB.INI
  325.    file under [brequestDPMI].
  326.  
  327.    NOVDB.INI is the Novell initialization file for the Windows Requester.
  328.  
  329.    Tasks = #            Specifies how many concurrent tasks may use the
  330.                         Windows Requester. The default value for this
  331.                         configuration option is 10.
  332.    Local = Yes/No       Instructs the Windows Requester to use client-based
  333.                         Btrieve for accessing files locally. The default
  334.                         value for this configuration option is No.
  335.    Chkparms = Yes/No    Instructs the Windows Requester to validate pointers
  336.                         passed to it. You should use this option only
  337.                         during development. The default value for this
  338.                         configuration option is No.
  339.    Free Memory = Yes/No Allocates and frees real-mode memory on each
  340.                         request. The Windows Requester uses a buffer of
  341.                         real-mode memory to communicate with the DOS
  342.                         Requester. Since real-mode memory is a scarce
  343.                         resource in Windows, your application should
  344.                         not retain it long term.The default value for this
  345.                         configuration option is No.
  346.  
  347.                         NOTE:  Specifying Yes to the Free Memory option
  348.                                degrades performance.
  349.  
  350.  
  351. Loading the Windows Requester
  352.  
  353.    The DOS Requester must be loaded before the Windows Requester can load.
  354.    An application may load the Windows Requester in one of the following two
  355.    ways:
  356.  
  357.    Implicitly - Your application can implicitly load the Btrieve Requester
  358.    by either linking with the import library WBTRCALL.LIB or by specifying
  359.    imported functions in the application definition file. When an
  360.    application loads a DLL implicitly, the operating system automatically
  361.    loads the DLL when the application is started.
  362.  
  363.    Explicitly - Your application may load the Windows Requester explicitly
  364.    using the operating system API functions. The operating system does not
  365.    load the DLL until notified to do so.
  366.  
  367.  
  368. Unloading the Windows Requester
  369.  
  370.    At a Windows workstation, the operating system removes the dynamic link
  371.    routines from memory when the application terminates or when the
  372.    application explicitly unloads the DLLs using the operating system API.
  373.  
  374.  
  375.    NOTE:  Logging out of one or more servers from a workstation does not
  376.           close Btrieve files or terminate the Btrieve SPX connection
  377.           to the server. To close files and terminate the connection,
  378.           you must either issue a STOP command or reboot the server.
  379.           A Reset operation does not terminate the SPX connection.
  380.  
  381. ========================================================================
  382. ** End of BTRREQ.DOC **
  383.  
  384.